home *** CD-ROM | disk | FTP | other *** search
- /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is
- * Netscape Communications Corporation.
- * Portions created by the Initial Developer are Copyright (C) 1998
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- * Akkana Peck <akkana@netscape.com>
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either the GNU General Public License Version 2 or later (the "GPL"), or
- * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
-
- #include "nsISupports.idl"
-
- interface nsIDOMRange;
- interface nsIWordBreaker;
-
- [scriptable, uuid(75125d55-37ee-4575-b9b5-f33bfa68c2a1)]
- interface nsIFind : nsISupports
- {
- attribute boolean findBackwards;
- attribute boolean caseSensitive;
-
- /**
- * Use "find entire words" mode by setting to a word breaker
- * or null, to disable "entire words" mode.
- */
- attribute nsIWordBreaker wordBreaker;
-
- /**
- * Find some text in the current context. The implementation is
- * responsible for performing the find and highlighting the text.
- *
- * @param aPatText The text to search for.
- * @param aSearchRange A Range specifying domain of search.
- * @param aStartPoint A Range specifying search start point.
- * If not collapsed, we'll start from
- * end (forward) or start (backward).
- * May be null; if so, we'll start at the start
- * (forward) or end (back) of aSearchRange.
- * @param aEndPoint A Range specifying search end point.
- * If not collapsed, we'll end at
- * end (forward) or start (backward).
- * May be null; if so, we'll end at the end
- * (forward) or start (back) of aSearchRange.
- * @retval A range spanning the match that was found (or null).
- */
- nsIDOMRange Find(in wstring aPatText, in nsIDOMRange aSearchRange,
- in nsIDOMRange aStartPoint, in nsIDOMRange aEndPoint);
- };
-